Improve user experience when API token fails to auth #250
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously, the error message is shown as a stack trace, which is a lot extra information to process. In addition, it refers to an API needing a token, but doesn't mention which one is expected and that it's pulled from the environment. This does two things: - Update the CLI to rescue the authentication error, and re-raise as a Thor::Error. These are shown as text, and cause the CLI to exit with a non-zero exit code. - Add more details about which API provider is expected and which environment variable is expected.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I gave an overview of this idea on #249
My thought is that
Roast::CLIshould rescue any errors that it can give more detailed explanation of what it means and/or how to fix. For example, when running Roast, and the API fails to authenticate, we shouldn't be showing a backtrace, but instead instructions on how to fix.TODO:
Thor::Errorthe best way to show this? Or should we just output to the terminal? should we exit explicitly, or handle as an exception?